eProd EIE – UIS Command Component Parameters

UIS Command Component Parameters

The following tables list and describe the parameters specific to the UIS command component types for this remote device:

For more general information about UIS command component parameters, see UIS Command Components. The DG_F_DEV (Get data group from device) and DG_T_DEV (Send data group to device) command component types are configured in the template file. The other command component types are considered ‘special’ and are defined in the EIE editor code. See Special UIS Command Component Types for more information.

CYUPDTPT

Update CygNet Point updates the record for a CygNet point. CYUPDTPT has the following command parameters:

Parameter	Required	Description
FOnErr	No	Fail cmd on update error indicates to abort the UIS command if any update errors are encountered. The errors that might come up include: if the point specified in the Fac, Serv, Site, or UDC parameters does not exist, or if the point exists in a different UIS and any messaging errors or communication failure to that service comes up.
Fac	Yes	Facility for pt identifies the facility of the point to update.
Serv	No	Service for pt identifies the SERVICE of the point to update.
Site	No	Site for pt identifies the SITE of the point to update.
UDC	Yes	UDC for pt identifies the UDC of the point to update.
UType	No	Update type indicates the type of update. Value options are 0 - 3, where 0=Completion, 1=Success, 2=Failure, 3=Creation.
UsrMsk	No	User bit mask specifies the user bit mask of the point to update.
UsrVal	No	User bit value to match specifies the user bit value to match when updating the point record.
Value	No	Value indicates the point value to update.

CYWAITPT

Wait for CygNet Point signals the UIS to wait to perform a command until the value of the specified CygNet point changes to a specified value.

CYWAITPT must be the first command component added to a UIS command. You cannot add other instances of CYWAITPT to a UIS command.

CYWAITPT has the following command parameters:

Parameter	Required	Description
Dur	Yes	Duration is the amount of time (in HH:MM:SS or HH:MM or HH) for the UIS command to wait for the point value to change before timing out.
FOnErr	No	Fail on point error indicates to abort the UIS command if any error conditions are encountered. The point errors that might come up include: if the point specified in the Fac, Serv, Site, or UDC parameters does not exist, or if the point exists in a different UIS and any messaging errors or communication failure to that service comes up.
Fac	Yes	Facility for pt identifies the facility of the point on which to wait for the point value to change before performing the UIS command.
Int	Yes	Interval indicates the frequency (in HH:MM:SS or HH:MM or HH) with which the UIS will check the point’s value to see if it has changed.
Serv	No	Service for pt identifies the SERVICE of the point on which to wait for the point value to change before performing the UIS command.
Site	No	Site for pt identifies the SITE of the point on which to wait for the point value to change before performing the UIS command.
UDC	Yes	UDC for pt identifies the UDC of the point on which to wait for the point value to change before performing the UIS command.
UsrMsk	No	User bit mask specifies the user bit mask on which to wait for the status bit change before issuing the UIS command. Note: The user status bit parameters (UsrMsk and UsrVal) only apply to the extended status field of the point record, so they will not match anything in the base status.
UsrVal	No	User bit value to match specifies the user bit value to match before issuing the UIS command.
Value	No	Value to match specifies the value on which to wait for the point to change to before issuing the UIS command. Note: You can set parameters for both the point user status AND point value. So you can match either one by itself, or you can specify that both must match your parameter values.

DG_F_DEV

Get data group from device retrieves a data group from a field device. The Parent XML Element is uccRecvParms. The following parameters are available for each specified data group type.

Data Group Type	Parameter	Required	Description
DynaCard	Cnt	No	Card Count defines the number of cards available to the selected "Dynagraph Card" (DynaCard) data group. Value options are integers from 1 to 5.
Rep	No	Representation defines where card data comes from and how it is displayed. Value options are the following integers: 0: surface 1: surface+downhole 2: downhole
EventId	No	EventId Value options are integers from 0 to 255.
InclPlain	No	InclPlain finds last Plain or Alarm event when event ID is omitted (ordinal 6). Value options are Boolean.
EvtDir	Val1	No	Fault Events defines whether or not Fault events are reported in the "Event Directory" data group. A Fault event indicates an exception, malfunction, or other process failure. It is the most severe event type. Value options are Boolean.
Val2	No	Alarm Events defines whether or not Alarm events are reported in the "Event Directory" data group. An Alarm event occurs when an alarm flag is set in the controller. Value options are Boolean.
Val3	No	Plain Events defines whether or not Plain events are reported in the "Event Directory" data group. A Plain event is any event that is not an Alarm or Fault event. Can be thought of as normal. Value options are Boolean.
EventCnt	No	Event Count Value options are integers from 0 to 255.
SingleParm	paramID	Yes	Parameter ID defines a device-specific parameter ID. Value options are integers.
DataType	Yes	Data Type defines the type of data stored at the specified Parameter ID. Value options are strings.
Desc	No	Description Value options are strings.
FacUdc	No	Facility.UDC for Point Processing provides a means to specify a UDC to which to map the specified data point; it requires a corresponding point in the Point Service (PNT). Value options are strings that specify a Facility.UDC combination.

Data Group Type

Parameter

Required

Description

DynaCard

Cnt

Card Count defines the number of cards available to the selected "Dynagraph Card" (DynaCard) data group.

Value options are integers from 1 to 5.

Rep

Representation defines where card data comes from and how it is displayed.

Value options are the following integers:

0: surface
1: surface+downhole
2: downhole

EventId

EventId

Value options are integers from 0 to 255.

InclPlain

InclPlain finds last Plain or Alarm event when event ID is omitted (ordinal 6).

Value options are Boolean.

EvtDir

Val1

Fault Events defines whether or not Fault events are reported in the "Event Directory" data group. A Fault event indicates an exception, malfunction, or other process failure. It is the most severe event type.

Value options are Boolean.

Val2

Alarm Events defines whether or not Alarm events are reported in the "Event Directory" data group. An Alarm event occurs when an alarm flag is set in the controller.

Value options are Boolean.

Val3

Plain Events defines whether or not Plain events are reported in the "Event Directory" data group. A Plain event is any event that is not an Alarm or Fault event. Can be thought of as normal.

Value options are Boolean.

EventCnt

Event Count

Value options are integers from 0 to 255.

SingleParm

paramID

Yes

Parameter ID defines a device-specific parameter ID.

Value options are integers.

DataType

Yes

Data Type defines the type of data stored at the specified Parameter ID.

Value options are strings.

Desc

Description

Value options are strings.

FacUdc

Facility.UDC for Point Processing provides a means to specify a UDC to which to map the specified data point; it requires a corresponding point in the Point Service (PNT).

Value options are strings that specify a Facility.UDC combination.

DG_T_DEV

Send data group to device sends a data group to a field device. The parent XML Element is uccSendParms. The following parameters are available for each specified data group type.

Data Group Type	Parameter	Required	Description
CmdCfgMsg	parmId	Yes	Parameter ID defines the manufacturer parameter number that applies to this "Command Message (Configurable)" data group. Value options are limited to those documented in manufacturer documentation. Sample templates expose relevant Command Action (CA) parameters.
CmdMsg	CommandId	Yes	Command ID defines the Command Action (CA) to be enacted by the "Command Message" (CmdMsg) data group. Value options are as follows: 0: Turn Well On 1: Force Well Into Idle Time 2: Clear Errors 3: Force Off Until Reset
SingleParm	DataType	Yes	Data Type defines the type of data stored at the specified Parameter ID. Value options are strings.
Desc	No	Description Value options are strings.
FacUdc	No	Facility.UDC for Point Processing provides a means to specify a UDC to which to map the specified data point; it requires a corresponding point in the Point Service (PNT). Value options are strings that specify a Facility.UDC combination.
ParamID	Yes	Parameter ID defines a device-specific parameter ID. Value options are integers.
Value	Yes	Value defines a value to be sent to a "Single Parameter" (SingleParm) data group. Value options are strings.

Data Group Type

Parameter

Required

Description

CmdCfgMsg

parmId

Yes

Parameter ID defines the manufacturer parameter number that applies to this "Command Message (Configurable)" data group.

Value options are limited to those documented in manufacturer documentation. Sample templates expose relevant Command Action (CA) parameters.

CmdMsg

CommandId

Yes

Command ID defines the Command Action (CA) to be enacted by the "Command Message" (CmdMsg) data group.

Value options are as follows:

0: Turn Well On
1: Force Well Into Idle Time
2: Clear Errors
3: Force Off Until Reset

SingleParm

DataType

Yes

Data Type defines the type of data stored at the specified Parameter ID.

Value options are strings.

Desc

Description

Value options are strings.

FacUdc

Facility.UDC for Point Processing provides a means to specify a UDC to which to map the specified data point; it requires a corresponding point in the Point Service (PNT).

Value options are strings that specify a Facility.UDC combination.

ParamID

Yes

Parameter ID defines a device-specific parameter ID.

Value options are integers.

Value

Yes

Value defines a value to be sent to a "Single Parameter" (SingleParm) data group.

Value options are strings.